Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
Flatland
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
sfwatergit
Flatland
Commits
ee7f216b
Commit
ee7f216b
authored
5 years ago
by
spmohanty
Browse files
Options
Downloads
Patches
Plain Diff
Update Contribution guidelines
parent
7604bfb8
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.rst
+15
-15
15 additions, 15 deletions
CONTRIBUTING.rst
with
15 additions
and
15 deletions
CONTRIBUTING.rst
+
15
−
15
View file @
ee7f216b
...
@@ -15,7 +15,7 @@ Types of Contributions
...
@@ -15,7 +15,7 @@ Types of Contributions
Report Bugs
Report Bugs
~~~~~~~~~~~
~~~~~~~~~~~
Report bugs at https://git
hub.com/spMohanty
/flatland/issues.
Report bugs at https://git
lab.aicrowd.com/flatland
/flatland/issues.
If you are reporting a bug, please include:
If you are reporting a bug, please include:
...
@@ -26,13 +26,13 @@ If you are reporting a bug, please include:
...
@@ -26,13 +26,13 @@ If you are reporting a bug, please include:
Fix Bugs
Fix Bugs
~~~~~~~~
~~~~~~~~
Look through the
GitHub issues
for bugs. Anything tagged with "bug" and "help
Look through the
Repository Issue Tracker
for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.
wanted" is open to whoever wants to implement it.
Implement Features
Implement Features
~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~
Look through the
GitHub issues
for features. Anything tagged with "enhancement"
Look through the
Repository Issue Tracker
for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.
and "help wanted" is open to whoever wants to implement it.
Write Documentation
Write Documentation
...
@@ -45,7 +45,7 @@ articles, and such.
...
@@ -45,7 +45,7 @@ articles, and such.
Submit Feedback
Submit Feedback
~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~
The best way to send feedback is to file an issue at https://git
hub.com/spMohanty
/flatland/issues.
The best way to send feedback is to file an issue at https://git
lab.aicrowd.com/flatland
/flatland/issues.
If you are proposing a feature:
If you are proposing a feature:
...
@@ -59,10 +59,10 @@ Get Started!
...
@@ -59,10 +59,10 @@ Get Started!
Ready to contribute? Here's how to set up `flatland` for local development.
Ready to contribute? Here's how to set up `flatland` for local development.
1. Fork the `flatland` repo on
GitHub
.
1. Fork the `flatland` repo on
https://gitlab.aicrowd.com/flatland/flatland
.
2. Clone your fork locally::
2. Clone your fork locally::
$ git clone git@git
hub.com:your_name_here
/flatland.git
$ git clone git@git
lab.aicrowd.com:flatland
/flatland.git
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
...
@@ -85,25 +85,25 @@ Ready to contribute? Here's how to set up `flatland` for local development.
...
@@ -85,25 +85,25 @@ Ready to contribute? Here's how to set up `flatland` for local development.
To get flake8 and tox, just pip install them into your virtualenv.
To get flake8 and tox, just pip install them into your virtualenv.
6. Commit your changes and push your branch to Git
Hu
b::
6. Commit your changes and push your branch to Git
la
b::
$ git add .
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
$ git push origin name-of-your-bugfix-or-feature
7. Submit a
pull
request through the Git
Hub
website.
7. Submit a
merge
request through the Git
lab repository
website.
Pull
Request Guidelines
Merge
Request Guidelines
-----------------------
-----------------------
Before you submit a
pull
request, check that it meets these guidelines:
Before you submit a
merge
request, check that it meets these guidelines:
1. The
pull
request should include tests.
1. The
merge
request should include tests.
2. If the
pull
request adds functionality, the docs should be updated. Put
2. If the
merge
request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
feature to the list in README.rst.
3. The
pull
request should work for Python
2.7,
3.
4
, 3.
5 and 3.6,
and for PyPy. Check
3. The
merge
request should work for Python 3.
6
, 3.
7
and for PyPy. Check
https://
travis-ci.org/spMohanty/flatland/pull_request
s
https://
gitlab.aicrowd.com/flatland/flatland/pipeline
s
and make sure that the tests pass for all supported Python versions.
and make sure that the tests pass for all supported Python versions.
Tips
Tips
...
@@ -125,4 +125,4 @@ $ bumpversion patch # possible: major / minor / patch
...
@@ -125,4 +125,4 @@ $ bumpversion patch # possible: major / minor / patch
$ git push
$ git push
$ git push --tags
$ git push --tags
Travis will then deploy to PyPI if tests pass.
Travis will then deploy to PyPI if tests pass.
(To be configured properly by Mohanty)
\ No newline at end of file
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment