Skip to content

Commit

Permalink
Ross org cleanup (#143)
Browse files Browse the repository at this point in the history
* contributing guide line in PR template
* ross-org in contrib guide
* more carothersc -> ross-org
* doxygen header link
  • Loading branch information
gonsie authored Mar 25, 2019
1 parent 1979605 commit 497af49
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 13 deletions.
10 changes: 5 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ There are many ways to contribute to ROSS:
- Create and release a model.
Like any simulation engine, ROSS is always looking for new models and new model developers.
This is also the best way to learn about ROSS and its API.
- File a bug or request a feature through [GitHub Issues](http://github.com/carothersc/ROSS/issues).
- File a bug or request a feature through [GitHub Issues](http://github.com/ROSS-org/ROSS/issues).
We are always looking to improve ROSS to make it more stable for our users.
Feature requests and related discussions are located here as well.
- The best way to ensure a bug or feature request is addressed is to do it yourself!
Spelunking through the ROSS core can be a enlightening journey.
Once you've made the change, feel free to create a [pull request](https://github.com/carothersc/ROSS/pulls).
Once you've made the change, feel free to create a [pull request](https://github.com/ROSS-org/ROSS/pulls).
Between our continuous integration testing and our experienced ROSS core team, we will ensure your change is safe before deploying it to the master branch.

## Small Changes
Expand Down Expand Up @@ -40,12 +40,12 @@ First, the new feature or major change must pass all of the existing TravisCI te
Next, the test coverage must increase (or at least stay the same).
For new features, this usually means that a new test must written.
There are typically two options for a test:
- Add a new test to PHOLD model (see [models/phold/CMakeLists.txt](https://github.com/carothersc/ROSS/blob/master/models/phold/CMakeLists.txt)).
- Add a new test to PHOLD model (see [models/phold/CMakeLists.txt](https://github.com/ROSS-org/ROSS/blob/master/models/phold/CMakeLists.txt)).
- Create a new model which tests your feature and add this model to the ROSS-Models repository.

### ROSS Model Changes

The [ROSS-Models repository](http://github.com/carothersc/ROSS-Models) contains models which are no longer under development.
The [ROSS-Models repository](http://github.com/ROSS-org/ROSS-Models) contains models which are no longer under development.
If your new feature is a major API change to ROSS, the models in this repository must be updated.
The workflow to update the ROSS-Models submodule is as follows:

Expand All @@ -72,7 +72,7 @@ Here you can fork the CODES repository and create a pull request with any requir

In order to keep our documentation up-to-date, any new feature or major change must be documented before it is merged into the master branch.
The easiest way to document the change is to create a new blog post for our website.
The [contributing guide](https://github.com/carothersc/ROSS/blob/gh-pages/CONTRIBUTING.md) in our gh-pages branch documents this process.
The [website contributing guide](https://github.com/ROSS-org/ross-org.github.io/blob/master/CONTRIBUTING.md) documents this process.

## Versioning and New Releases

Expand Down
5 changes: 2 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@

If this merge represents a feature addition to ROSS, the following items must be completed before the branch will be merged:

- [ ] Document the feature on the blog (See the [Contributing guide](https://github.com/carothersc/ROSS/blob/gh-pages/CONTRIBUTING.md) in the gh-pages branch).
- [ ] Document the feature on the blog (See the [website Contributing guide](https://github.com/ROSS-org/ross-org.github.io/blob/master/CONTRIBUTING.md)).
Include a link to your blog post in the Pull Request.
- [ ] Builds should cleanly compile with -Wall and -Wextra.
- [ ] Builds should cleanly compile with -Wall and -Wextra.
- [ ] One or more TravisCI tests should be created (and they should pass)
- [ ] Through the TravisCI tests, coverage should increase
- [ ] Test with CODES to ensure everything continues to work

2 changes: 1 addition & 1 deletion core/ross.pc.in
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ ross_libs=-lROSS -lm
Name: ROSS
Description: Rensselaer's Optimistic Simulation System
Version: 1.0
URL: https://github.com/carothersc/ROSS
URL: https://github.com/ROSS-org/ROSS
Requires:
Libs: ${ross_ldflags} ${ross_libs}
Cflags: ${ross_cflags}
2 changes: 1 addition & 1 deletion docs/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<!--END PROJECT_LOGO-->
<!--BEGIN PROJECT_NAME-->
<td style="padding-left: 0.5em;">
<a href="https://github.com/carothersc/ROSS">
<a href="https://github.com/ROSS-org/ROSS">
<div id="projectname">$projectname
<!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
</div>
Expand Down
6 changes: 3 additions & 3 deletions models/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The ROSS repository currently links to two model repositories:
- [A Template Model](http://github.com/nmcglohon/template-model) that can be used as a starting point for any new model.
- [A Suite of Stable Models](http://github.com/carothersc/ROSS-Models) which contains several completed models.
- [A Suite of Stable Models](http://github.com/ROSS-org/ROSS-Models) which contains several completed models.

## Building Existing Models

Expand All @@ -12,7 +12,7 @@ git submodule init
git submodule update
```
Then build ROSS as you regularly would.
Be sure to turn on the option to ROSS_BUILD_MODELS in CMake (more details can be found on the [wiki page](http://github.com/carothersc/ROSS/wiki/Installation)).
Be sure to turn on the option to ROSS_BUILD_MODELS in CMake (more details can be found on the [wiki page](http://github.com/ROSS-org/ROSS/wiki/Installation)).

## Creating Your Own Model

Expand All @@ -22,4 +22,4 @@ Sym-link your model into this folder and CMake will automatically find it for bu
cd ~/Projects/ROSS/models
ln -s ~/Projects/my-model ./
```
For more details on creating a model please check out the [wiki page](http://github.com/carothersc/ROSS/wiki/Constructing-the-Model).
For more details on creating a model please check out the [wiki page](http://github.com/ROSS-org/ROSS/wiki/Constructing-the-Model).

0 comments on commit 497af49

Please sign in to comment.